home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsITextToSubURI.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.5 KB  |  83 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40.  
  41. %{C++
  42. // {8B042E22-6F87-11d3-B3C8-00805F8A6670}
  43. #define NS_TEXTTOSUBURI_CID { 0x8b042e22, 0x6f87, 0x11d3, { 0xb3, 0xc8, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
  44. #define NS_ITEXTTOSUBURI_CONTRACTID "@mozilla.org/intl/texttosuburi;1"
  45. %}
  46.  
  47. [scriptable, uuid(8B042E24-6F87-11d3-B3C8-00805F8A6670)]
  48. interface nsITextToSubURI : nsISupports
  49. {
  50.     string ConvertAndEscape(in string charset, in wstring text);
  51.     wstring UnEscapeAndConvert(in string charset, in string text);
  52.  
  53.   /**
  54.    * Unescapes the given URI fragment (for UI purpose only)
  55.    * Note: 
  56.    * <ul>
  57.    *  <li> escaping back the result (unescaped string) is not guaranteed to 
  58.    *       give the original escaped string
  59.    *  <li> In case of a conversion error, the URI fragment (escaped) is 
  60.    *       assumed to be in UTF-8 and converted to AString (UTF-16)
  61.    *  <li> Always succeeeds (callers don't need to do error checking)
  62.    * </ul>
  63.    *
  64.    * @param aCharset the charset to convert from
  65.    * @param aURIFragment the URI (or URI fragment) to unescape
  66.    * @return Unescaped aURIFragment  converted to unicode
  67.    */
  68.   AString unEscapeURIForUI(in ACString aCharset, in AUTF8String aURIFragment);
  69.  
  70.   /**
  71.    * Unescapes only non ASCII characters in the given URI fragment 
  72.    * note: this method assumes the URI as UTF-8 and fallbacks to the given charset
  73.    * in case the data is not UTF-8
  74.    *
  75.    * @param aCharset the charset to convert from
  76.    * @param aURIFragment the URI (or URI fragment) to unescape
  77.    * @return Unescaped aURIFragment  converted to unicode
  78.    * @throws NS_ERROR_UCONV_NOCONV when there is no decoder for aCharset
  79.    *         or error code of nsIUnicodeDecoder in case of conversion failure
  80.    */
  81.   AString unEscapeNonAsciiURI(in ACString aCharset, in AUTF8String aURIFragment);
  82. };
  83.